c16x12r.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef C16X12R_H
#define C16X12R_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"




#define C16X12R_REG_PAGE_SELECT                 0xFD
#define C16X12R_REG_PAGE_LOCK                   0xFE
#define C16X12R_REG_INT_MASK                    0xF0
#define C16X12R_REG_INT_STATUS                  0xF1

#define C16X12R_PAGE_REG_LED_ON_OFF             0x0000
#define C16X12R_PAGE_REG_LED_OPEN               0x0018
#define C16X12R_PAGE_REG_LED_SHORT              0x0030
#define C16X12R_PAGE_REG_PWM                    0x0100
#define C16X12R_PAGE_REG_MODE                   0x0200
#define C16X12R_PAGE_REG_CONFIG                 0x0300
#define C16X12R_PAGE_REG_GLOBAL_CURRENT_CTRL    0x0301
#define C16X12R_PAGE_REG_BREATH_ABM1_CTRL1      0x0302
#define C16X12R_PAGE_REG_BREATH_ABM1_CTRL2      0x0303
#define C16X12R_PAGE_REG_BREATH_ABM1_CTRL3      0x0304
#define C16X12R_PAGE_REG_BREATH_ABM1_CTRL4      0x0305
#define C16X12R_PAGE_REG_BREATH_ABM2_CTRL1      0x0306
#define C16X12R_PAGE_REG_BREATH_ABM2_CTRL2      0x0307
#define C16X12R_PAGE_REG_BREATH_ABM2_CTRL3      0x0308
#define C16X12R_PAGE_REG_BREATH_ABM2_CTRL4      0x0309
#define C16X12R_PAGE_REG_BREATH_ABM3_CTRL1      0x030A
#define C16X12R_PAGE_REG_BREATH_ABM3_CTRL2      0x030B
#define C16X12R_PAGE_REG_BREATH_ABM3_CTRL3      0x030C
#define C16X12R_PAGE_REG_BREATH_ABM3_CTRL4      0x030D
#define C16X12R_PAGE_REG_TIME_UPDATE            0x030E
#define C16X12R_PAGE_REG_SWY_PULLUP_SELECT      0x030F
#define C16X12R_PAGE_REG_CSX_PULLDOWN_SELECT    0x0310
#define C16X12R_PAGE_REG_RESET                  0x0311
 // c16x12r_reg



#define C16X12R_PAGE_SELECT_0                   0x00
#define C16X12R_PAGE_SELECT_1                   0x01
#define C16X12R_PAGE_SELECT_2                   0x02
#define C16X12R_PAGE_SELECT_3                   0x03

#define C16X12R_PAGE_LOCK                       0x00
#define C16X12R_PAGE_UNLOCK                     0xC5

#define C16X12R_MODE_PWM                        0x00
#define C16X12R_MODE_ABM1                       0x01
#define C16X12R_MODE_ABM2                       0x02
#define C16X12R_MODE_ABM3                       0x03

#define C16X12R_CONFIG_SYNC_HIGH_Z              0x00
#define C16X12R_CONFIG_SYNC_MASTER              0x40
#define C16X12R_CONFIG_SYNC_SLAVE               0x80
#define C16X12R_CONFIG_SYNC_MASK                0xC0
#define C16X12R_CONFIG_OSD_DIS                  0x00
#define C16X12R_CONFIG_OSD_EN                   0x04
#define C16X12R_CONFIG_OSD_MASK                 0x04
#define C16X12R_CONFIG_B_EN_PWM                 0x00
#define C16X12R_CONFIG_B_EN_ABM                 0x02
#define C16X12R_CONFIG_B_EN_MASK                0x02
#define C16X12R_CONFIG_SSD_SHUTDOWN             0x00
#define C16X12R_CONFIG_SSD_NORMAL               0x01
#define C16X12R_CONFIG_SSD_MASK                 0x01

#define C16X12R_CURRENT_MIN                     0x00
#define C16X12R_CURRENT_DEFAULT                 0xA0
#define C16X12R_CURRENT_MAX                     0xFF

#define C16X12R_PWM_DUTY_MIN                    0x00
#define C16X12R_PWM_DUTY_DEFAULT                0xA0
#define C16X12R_PWM_DUTY_MAX                    0xFF

#define C16X12R_LED_STATE_OFF                   0
#define C16X12R_LED_STATE_ON                    1

#define C16X12R_NUM_LEDS                        192
#define C16X12R_NUM_ROWS                        16
#define C16X12R_NUM_COLUMNS                     12

#define C16X12R_ROTATION_V_0                    0x00
#define C16X12R_ROTATION_V_180                  0x01
#define C16X12R_ROTATION_H_0                    0x10
#define C16X12R_ROTATION_H_180                  0x11

#define C16X12R_DEVICE_ADDRESS_A2A1_00          0x50
#define C16X12R_DEVICE_ADDRESS_A2A1_01          0x53
#define C16X12R_DEVICE_ADDRESS_A2A1_10          0x5C
#define C16X12R_DEVICE_ADDRESS_A2A1_11          0x5F
 // c16x12r_set



#define C16X12R_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.sdb = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.intb = MIKROBUS( mikrobus, MIKROBUS_INT )
 // c16x12r_map // c16x12r

typedef struct
{
    // Output pins
    digital_out_t sdb;          
    digital_out_t rst;          
 
    // Input pins
    digital_in_t intb;          
 
    // Modules
    i2c_master_t i2c;           
 
    // I2C slave address
    uint8_t slave_address;      
 
    uint8_t leds[ C16X12R_NUM_COLUMNS * C16X12R_NUM_ROWS / 8 ];     
 
    uint8_t text_rotation;      
 
} c16x12r_t;

typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
 
    pin_name_t sdb;             
    pin_name_t rst;             
    pin_name_t intb;            
 
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
 
} c16x12r_cfg_t;

typedef enum
{
    C16X12R_OK = 0,
    C16X12R_ERROR = -1
 
} c16x12r_return_value_t;


void c16x12r_cfg_setup ( c16x12r_cfg_t *cfg );

err_t c16x12r_init ( c16x12r_t *ctx, c16x12r_cfg_t *cfg );

err_t c16x12r_default_cfg ( c16x12r_t *ctx );

err_t c16x12r_write_reg ( c16x12r_t *ctx, uint8_t reg, uint8_t data_in );

err_t c16x12r_write_regs ( c16x12r_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );

err_t c16x12r_read_reg ( c16x12r_t *ctx, uint8_t reg, uint8_t *data_out );

err_t c16x12r_read_regs ( c16x12r_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );

void c16x12r_enable_device ( c16x12r_t *ctx );

void c16x12r_disable_device ( c16x12r_t *ctx );

void c16x12r_reset_device_i2c ( c16x12r_t *ctx );

void c16x12r_set_rst_pin ( c16x12r_t *ctx, uint8_t state );

uint8_t c16x12r_get_intb_pin ( c16x12r_t *ctx );

err_t c16x12r_lock_page ( c16x12r_t *ctx );

err_t c16x12r_unlock_page ( c16x12r_t *ctx );

err_t c16x12r_select_page ( c16x12r_t *ctx, uint8_t page );

err_t c16x12r_write_page_reg ( c16x12r_t *ctx, uint16_t page_reg, uint8_t data_in );

err_t c16x12r_write_page_regs ( c16x12r_t *ctx, uint16_t page_reg, uint8_t *data_in, uint8_t len );

err_t c16x12r_read_page_reg ( c16x12r_t *ctx, uint16_t page_reg, uint8_t *data_out );

err_t c16x12r_read_page_regs ( c16x12r_t *ctx, uint16_t page_reg, uint8_t *data_out, uint8_t len );

err_t c16x12r_fill_screen ( c16x12r_t *ctx );

err_t c16x12r_clear_screen ( c16x12r_t *ctx );

err_t c16x12r_set_pwm ( c16x12r_t *ctx, uint8_t duty );

err_t c16x12r_set_mode ( c16x12r_t *ctx, uint8_t mode );

void c16x12r_set_led_state ( c16x12r_t *ctx, uint8_t led_num, uint8_t state );

err_t c16x12r_write_leds ( c16x12r_t *ctx );

err_t c16x12r_draw_picture ( c16x12r_t *ctx, const uint16_t *image );

err_t c16x12r_write_char ( c16x12r_t *ctx, uint8_t data_in );

err_t c16x12r_write_string ( c16x12r_t *ctx, uint8_t *data_in, uint16_t speed_ms );
 
#ifdef __cplusplus
}
#endif
#endif // C16X12R_H
 // c16x12r
 
// ------------------------------------------------------------------------ END